Edit an EBML File
Easy Button Markup Language (EBML) #ebml files are plain-text, so you can open them up in your favorite text editor, e.g.
- Notepad
- Notepad++
- Sublime Text
- VS Code
- CotEditor
- vi/Vim/Neovim
- Emacs/XEmacs
Syntax Summary
| Line Type | Syntax |
|---|---|
| Comment | "//" at the start of the line |
| EBML Line | "|" delimited, e.g. "Author | Name of Author" |
That's it! There are many kinds of EBML Lines, and some of them take more than one argument, or have more complex formatting. For the most part though that's it!
"Minimum" EBML file
The bare minimum an EBML file needs is a Number and a Title.
Each Process Folder Folder in a Process Library is named very specifically, as is the EBML file itself.
The pattern is:
Process Library/<Number> - <Title>/<Number> - <Title>.ebml
If for some reason [stanhope] is failing to operate on a particular process and you suspect a mismatch in the pattern above, do this: Audit a Library for Inconsistent Filename-Folder-Number-Title Combinations
Number | SG-TP-STYL-002
Title | Minimum Process
Author | Name of Author
Reviewer | Name of Reviewer
Revision | - | First formal release
Section | One Section
Step | One Step
Structure of an EBML file
The one-step example we'll work with
Here's the entire contents of a sample EBML file:
Template | TechCompany.css
Template | compact.css
Template | Secret.css
Number | DOC-NO-001
Title | This Is The Title
Author | First Last
Reviewer | First Last
Revision | 2 | Top is latest
Revision | 1 | Intermediate
Revision | 0 | Bottom is oldest
Subject | Flight Parts
Subject Image | flight-parts.png
Product | Flight Assembly
Product Image | flight-assembly.png
Section | Title text for this section
Step | Step title text
Warning | Text for the warning!
Image | image.png | Image caption
Action | Do this | Expect this | TPV
Action | Do this other thing | Expect this other result | No
Resource | Screwdriver, Phillips Head #2 | Calibrated
In this hypothetical, there's a Process Library that has a document number "DOC-NO-001" with the title "This Is The Title." The latest revision is "2" and the process applies to "Flight Parts" to produce "Flight Assembly."
The process, as written above, has one section, and that section has one step that uses a calibrated screwdriver.
Breakdown of the structure of the example
This process calls three template CSS files, each of which independently modifies the look of the output products (HTML and PDF) that stanhope renders. All three of these particular template files come in the free asset pack, and can be modified or forked to suit your needs.
Template | TechCompany.css
Template | compact.css
Template | Secret.css
These fields are essential to any process in your library, not only for indexing, but for accountability. As long as humans are involved in executing processes, the humans that developed the processes should be known and accessible.
Number | DOC-NO-001
Title | This Is The Title
Author | First Last
Reviewer | First Last
Revision | 2 | Top is latest
Revision | 1 | Intermediate
Revision | 0 | Bottom is oldest
Subject | Flight Parts
Subject Image | flight-parts.png
Product | Flight Assembly
Product Image | flight-assembly.png
Section | Title text for this section
Step | Step title text
Warning | Text for the warning!
Image | image.png | Image caption
Action | Do this | Expect this | TPV
Action | Do this other thing | Expect this other result | No
Resource | Screwdriver, Phillips Head #2 | Calibrated
Sections and Steps
All the real content happens at the Step level. SubSteps give rich content options to make each Step visual and data-rich.